Add template support for generate_docstring_hpp.py #4690
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Accept optional 5th parameter for simulator type
- Detect template format (with 'simulators' and 'common_methods' keys)
- Expand templates by replacing {{name}} and {{class}} placeholders
- Maintain backward compatibility for flat JSON format
- Generate simulator-specific docstring headers from single template
This was referenced Aug 22, 2025
hakonhagland
added
the
manual:irrelevant
Contributor
Author
|
jenkins build this please |
akva2
approved these changes
Sep 12, 2025
Member
akva2
left a comment
akva2
left a comment
There was a problem hiding this comment.
Looks fine. I wonder if the flat format is quickly turning into unused cruft, but we can keep it for now..
Member
|
jenkins build this opm-simulators=6418 please |
Member
|
jenkins build this please |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We need to extend the docstring extraction method to accommodate for multiple opm simulator python modules. Previously, there was only
opm.simulators.BlackOilSimulator, now (see OPM/opm-simulators#6075) there will also be aGasWaterSimulator(and possibly more in the future). To avoid docstring duplication among the different simulators, a template system was implemented see OPM/opm-simulators#6418 and OPM/opm-python-documentation#17 for more information.